Get Trade Requests

GET /api/trade-requests

Description

Retrieve trade requests based on various query parameters.

Path Parameters

Name	Type	Description
None		No parameters

Request Headers

Name	Type	Description
tenantId	string	The tenant ID (header)
userId	string	The user ID (header)
countryCode	string	The country code (header)

Query Parameters

Name	Type	Description
tradeRequestSearch	string	Search term for trade requests (query)
tradeRequestDateRange	string	Date range for trade requests, e.g., 2020-11-12,2022-11-15 (query)
tradeRequestBySellersIds	string	Filter by seller IDs (query)
tradeRequestByProductIds	string	Filter by product IDs (query)
tradeRequestIds	string	Filter by trade request IDs (query)
byBuyerIds	string	Filter by buyer IDs (query)
byBusinessIds	string	Filter by business IDs (query)
order	string	Order of results, available values: ASC, DESC (query)
page	string	Page number for pagination (query)
limit	string	Number of results per page (query)

Example

GET /api/trade-requests?tradeRequestSearch=example&tradeRequestDateRange=2020-11-12,2022-11-15&tradeRequestBySellersIds=seller123&tradeRequestByProductIds=prod456&tradeRequestIds=tr789&byBuyerIds=buyer012&byBusinessIds=bus345&order=ASC&page=1&limit=10
Content-Type: application/json
tenantId: string
userId: string
countryCode: string

Response Code: 200 - OK

Description

Successful response with trade request data.

Response Fields

Field	Type	Description
status	boolean	Indicates if the operation was successful
statusCode	integer	Status code
message	string	Response message
data	object	Data related to trade requests
errors	array	List of error messages, if any

Example

{
  "status": true,
  "statusCode": 0,
  "message": "Trade requests retrieved successfully",
  "data": {},
  "errors": [
    {
      "message": "Some error occurred",
      "descriptiveMessage": "Detailed error message"
    }
  ]
}

Headers

Content-Type	Value
apiKey	{{apiKey}}
tenantId	string
userId	string
countryCode	string

🔑 Authentication bearer

Param	Value	Type
token	{{accessCode}}	string